home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / qwack096.zip / QWACK.DOC < prev    next >
Text File  |  1992-04-09  |  10KB  |  237 lines
  1.  
  2.                           QWacK version 0.96 Beta
  3.      A QWK Mail Packet Interface for The Blue Wave Offline Mail Reader
  4.  
  5.                 Copyright (C) 1992 by Cutting Edge Computing
  6.                             All Rights Reserved.
  7.  
  8.  
  9.   LICENSE AGREEMENT
  10.   ~~~~~~~~~~~~~~~~~
  11.   This program and its documentation are FREE for use in a non-commercial
  12.   environment.  If this software is used in a commercial environment, you
  13.   must register this program with Cutting Edge Computing for a fee of $20,
  14.   or you must have a license for The Blue Wave Offline Mail Reader.
  15.   Registered commercial owners of The Blue Wave Offline Mail Reader may use
  16.   this program with no additional charge.
  17.  
  18.   Cutting Edge Computing is not responsible for any loss of data or system
  19.   down time resulting from the use of this program.  The user must agree to
  20.   use this program at their own risk.
  21.  
  22.   Users of this program must not alter this documentation nor the enclosed
  23.   executable file without the express written permission of Cutting Edge
  24.   Computing.  You are encouraged to share this program with others, so long
  25.   as ALL of the above conditions have been met.
  26.  
  27.  
  28.   PURPOSE
  29.   ~~~~~~~
  30.   The purpose of this software is to enable The Blue Wave Offline Mail
  31.   Reader to read mail packets created by QWK-compatible mail offline mail
  32.   doors.  After entering messages or replying to messages from the
  33.   QWK-compatible mail bundle, you can then use QWacK to convert your Blue
  34.   Wave Reader generated *.NEW reply file into a QWK-style *.REP bundle.
  35.   You can then upload the *.REP bundle to the originating QWK-compatible
  36.   mail door for processing.
  37.  
  38.   This program does *not* convert Blue Wave Mail Door-generated mail
  39.   packets into QWK readable files.
  40.  
  41.  
  42.   WARNING
  43.   ~~~~~~~
  44.   This software is a beta test copy.  This means that it is not guaranteed
  45.   to work in all situations, if indeed it works at all.  There may be some
  46.   incompatibilites with .REP files generated from Blue Wave mail bundles.
  47.   However, I have tried to cover all the bases and have personally tested
  48.   .REP files generated with QWacK on the following QWK-host systems:
  49.  
  50.   1)  Maximus-CBCS v2.01wb internal QWK system
  51.   2)  TomCat!
  52.   3)  QMail
  53.   4)  SuperBBS v1.16 internal QWK system
  54.   5)  MarkMail
  55.  
  56.   If you run into any inconsistencies, problems, incompatibilities, or
  57.   quirks, please let me know so that they can be taken care of.  Full
  58.   details for contacting me are at the very end of this document.
  59.  
  60.   I can be of more help if you can let me know the following in your bug
  61.   report:
  62.  
  63.   1)  The exact problem that occurs.
  64.   2)  Which mail door and version your QWK mail host is running.
  65.   3)  The BBS phone number that runs this mail door (so I can test it
  66.       myself if necessary).
  67.  
  68.  
  69.   REQUIREMENTS
  70.   ~~~~~~~~~~~~
  71.   QWacK itself uses less than 100K of memory.  However, depending on the
  72.   compression and decompression program that you are using, a considerable
  73.   bit more memory will be necessary.
  74.  
  75.   For example, ARJ in its "default" mode will need at least 300K of free
  76.   memory available.  In most cases, you will be able to get by in as little
  77.   as 250K.
  78.  
  79.  
  80.   INSTALLATION
  81.   ~~~~~~~~~~~~
  82.   It is recommended that QWACK.EXE and QWACK.CFG be placed in your Blue
  83.   Wave Reader's home directory (the same directory where BWAVE.EXE is
  84.   located), although this is not a requirement.
  85.  
  86.   Before attempting to run QWacK for the first time, it will be necessary
  87.   to edit the program's configuration file; QWACK.CFG.  A sample
  88.   configuration file should have been enclosed within QWacK's distribution
  89.   archive.  A description of all configuration items and their intended
  90.   purpose is described in detail in the sample configuration file.
  91.  
  92.   In order to execute properly, QWacK requires that QWACK.CFG be located in
  93.   the *same* directory as QWACK.EXE resides.
  94.  
  95.  
  96.   OPERATION
  97.   ~~~~~~~~~
  98.   After QWACK.CFG has been configured to your liking, you should be ready
  99.   to convert your QWK bundle(s) into a form readable by Blue Wave.
  100.  
  101.   In order to execute properly, you must give QWACK.EXE two command line
  102.   parameters.  The first command line parameter must be the mode to operate
  103.   in;  either "IN" or "OUT".  The second command line parameter must be the
  104.   name of the mail archive to process.  If the mail archive you want to
  105.   convert is not in the current subdirectory, you must specify the full
  106.   path and filename of the file to convert.
  107.  
  108.   Examples:
  109.   QWACK IN C:\BWAVE\DOWNLOAD\WILDBLUE.QWK
  110.   QWACK IN C:\BWAVE\DOWNLOAD\WILDBLUE.QW2
  111.   QWACK IN C:\BWAVE\DOWNLOAD\WILDBLUE      (QWacK will add the .QWK extension)
  112.  
  113.   QWACK OUT C:\BWAVE\UPLOAD\WILDBLUE.NEW
  114.   QWACK OUT C:\BWAVE\UPLOAD\WILDBLUE       (QWacK will add the .NEW extension)
  115.  
  116.  
  117.   During the processing of the mail packets, in both "OUT" and "IN" mode,
  118.   QWacK will create two working directories.  The working directories will
  119.   be used to store temporary files during the decompression and conversion
  120.   of your mail packets.  The names of the directories created are:
  121.  
  122.   \$QWKTEMP     -  Stores the temporary QWK files during conversion
  123.   \$BWTEMP      -  Stores the temporary Blue Wave files during conversion
  124.  
  125.   Under normal conditions, these temporary directories will be erased and
  126.   removed upon termination of the program.  However, if processing was
  127.   interrupted for one reason or another, you can safely delete any files in
  128.   these directories, and remove the directories yourself.
  129.  
  130.   QWack IN Mode
  131.   ~~~~~~~~~~~~~
  132.   The QWack "IN" mode is used to convert QWK-style mail bags into a form
  133.   readable by The Blue Wave Offline Mail Reader.  When you run QWacK in
  134.   this mode, it performs the following steps:
  135.  
  136.   1)  Decompresses the QWK bundle into the temporary \$QWKTEMP directory
  137.   2)  Builds the Blue Wave data files in the \$BWTEMP directory
  138.   3)  Compresses the resulting Blue Wave Bundle, and places it into the
  139.       'DownloadDir' which is defined in QWACK.CFG
  140.   4)  Erases and removes the two temporary working directories.
  141.  
  142.   If the conversion was successful, you can now read the converted mail
  143.   packet with your Blue Wave Offline Mail Reader.
  144.  
  145.  
  146.   QWacK OUT Mode
  147.   ~~~~~~~~~~~~~~
  148.   Use QWack "OUT" mode to convert a Blue Wave Reader generated *.NEW reply
  149.   file into a QWK-compatible *.REP file.  The following procedures will be
  150.   followed when running in this mode:
  151.  
  152.   1)  The *.NEW file specified on the command line will be decompressed
  153.       into the temporary \$BWTEMP subdirectory.
  154.   2)  QWacK will determine the name of the .REP file that it is going
  155.       to build, and check the `UploadDir' defined in QWACK.CFG to see if a
  156.       .REP bundle already exists by that name.  If QWacK locates an
  157.       existing .REP bundle, you will be prompted as to whether you would
  158.       like to overwrite or add to it.
  159.   3)  If you are adding to an existing .REP file, it will be decompressed
  160.       into the temporary \$QWKTEMP directory.
  161.   4)  The conversion program builds the QWK-compatible files in the
  162.       \$QWKTEMP directory.
  163.   5)  QWacK then compresses the resulting .REP bundle, and places it into
  164.       the `UploadDir' that you have defined in QWACK.CFG.
  165.   6)  The temporary working directories are then erased and removed.
  166.  
  167.   At this point you can upload your *.REP file to the QWK-based host
  168.   system, and download another new mail packet!
  169.  
  170.  
  171.  
  172.   SPECIAL CONSIDERATIONS
  173.   ~~~~~~~~~~~~~~~~~~~~~~
  174.   The original QWK format does not support FidoNet Netmail, Offline
  175.   Configurations, or File Requesting in a manner that is consistent between
  176.   mail doors.  Therefore, it will probably be necessary to ask your sysop
  177.   if these options are available to you though his or her QWK mail door,
  178.   and if they are, how you would go about using them.  The Blue Wave
  179.   Offline Mail Reader is not QWK-specific, and therefore you need to be
  180.   aware of the following:
  181.  
  182. * You should be aware that any Offline Configurations that you
  183.   make through The Blue Wave Offline Reader's "Offline Configuration Menu"
  184.   will be IGNORED by QWacK.  If the host QWK door supports "Add/Drop"
  185.   messages, simply enter them as you normally would with a QWK-style mail
  186.   reader.  It is also suggested that you answer "Y" to the "Private?"
  187.   question when entering add/drop messages.
  188.  
  189. * Any information entered through Blue Wave's "File Request" menu is
  190.   ignored.
  191.  
  192. * If you are attempting to enter Fidonet-style Netmail through The Blue
  193.   Wave Offline Mail Reader, it will be necessary to find out if the host
  194.   QWK mail door supports these types of messages, and how you should go
  195.   about entering them.  Your sysop should be able to help you, if you ask
  196.   politely :-).
  197.  
  198. * One of the biggest things to remember is that the QWK limit on message
  199.   FROM, TO, and SUBJECT fields is limited to 25 characters.  If you enter
  200.   more than 25 characters in any of these fields when creating messages and
  201.   replies, they will be truncated by QWacK when the mail packet is
  202.   converted.
  203.  
  204. * On systems (such as PCBoard) that allow you to enter messages in a
  205.   conference, but also allow you to set the "No Echo" flag (so that the
  206.   message does not get sent through a network to other systems), you will
  207.   need to begin your message subject with "NE:".  By using "NE:" as the
  208.   first three characters of your subject line, the message will not be
  209.   echoed to other systems.  [Note:  The host QWK mail door must support
  210.   this option!].
  211.  
  212.  
  213.   SUPPORT INFORMATION
  214.   ~~~~~~~~~~~~~~~~~~~
  215.   The Blue Wave Offline Mail Reader, The Blue Wave Offline Mail Doors, and
  216.   QWacK are written by George Hatchew, owner of Cutting Edge Computing in
  217.   Flint, Michigan (USA).  If you have trouble with any of these programs,
  218.   or you would like more information, you can get a hold of me in the
  219.   following ways:
  220.  
  221.   Netmail to 1:2240/176 (FidoNet)
  222.   Calling the BBS at (313) 743-8464 anytime except 4am-5am Eastern Time.
  223.   Protocols supported include 14400 HST and 14400 v32bis.
  224.  
  225.   Voice phone support is available at 313-743-WAVE.
  226.  
  227.   If you have access to the FidoNet "BLUEWAVE" echo, you can address a
  228.   message to me there.
  229.  
  230.   Or, you can send me mail to the following postal address:
  231.  
  232.   Cutting Edge Computing
  233.   PO Box 90476
  234.   Burton, Michigan  48509  (USA)
  235.  
  236.   Questions, comments, bug reports, and complaints are always welcome.
  237.